Browsing Kicksecure Documentation Offline
Reading documentation without internet connection.
Installation[edit]
Install package(s) git
following these instructions
1 Platform specific notice.
- Kicksecure: No special notice.
- Kicksecure-Qubes: In Template.
2 Update the package lists and upgrade the system .
sudo apt update && sudo apt full-upgrade
3 Install the git
package(s).
Using apt
command line
--no-install-recommends
option
is in most cases optional.
sudo apt install --no-install-recommends git
4 Platform specific notice.
- Kicksecure: No special notice.
- Kicksecure-Qubes: Shut down Template and restart App Qubes based on it as per Qubes Template Modification .
5 Done.
The procedure of installing package(s) git
is complete.
mkdir ~/Downloads/
cd ~/Downloads/
Use git
to download the Kicksecure wiki documentation.
git clone --depth=1 https://gitlab.com/kicksecure/kicksecure-wiki-html.git
Usage[edit]
x-www-browser ~/Downloads/kicksecure-wiki-html/Documentation.html
Advantages[edit]
- Very fast to browse once installed.
- Higher privacy.
Warnings[edit]
Limitations[edit]
- Some links might be broken.
- Large image view is broken.
- Simple code boxes. One has to manually select the contents of a code box for copy and paste.
- Boxes for "click on Expand on the right" are already expanded by default.
- Layout, tables look a bit different.
- Other imperfections.
Forum Discussion[edit]
https://forums.whonix.org/t/offline-documentation-discussion/413/89
Wiki Database Dump[edit]
Being able to make use of wiki database dumps requires skills in installation and running MediaWiki. This is unspecific to Kicksecure and unsupported.
A) Kicksecure wiki as mediawiki XML
database dump not including full history dumpContent.xml
but including all wiki images
- Using
git
, on gitlab. - Ugly binary file.
- Restoration possible in new mediawiki.
rsync://kicksecure.com/kicksecure/developer-meta-files/wiki-backup-dump-content-current
B) Kicksecure wiki as mediawiki XML
database dump including full history but not
including wiki images dumpContent.xml
dumpContent.xml.sha512sum
- Not using
git
because file size to big. - Ugly binary file.
- Restoration possible in new mediawiki.
rsync://kicksecure.com/kicksecure/developer-meta-files/wiki-backup-dump-content-full
Hints:
- Best to combine the two downloads above (full history A + all wiki images B).
- Possible to rsync from kicksecure.com.
Recommended steps to restore in a new mediawiki installation:
1) Restore full wiki history.
sudo -u www-data php /var/www/w/maintenance/importDump.php --uploads --dry-run /path/to/wiki-backup-dump-content-full/dumpContent.xml
- Path to mediawiki maintenance script
importDump.php
will likely be different. - drop:
--dry-run
- Probably also drop (likely broken)
--uploads
(not important)
2) Restore all wiki images.
sudo -u www-data php /var/www/w/maintenance/importImages.php /path/to/wiki/wiki-backup-dump-content-current/mediafiles
- Path to mediawiki maintenance script
importImages.php
will likely be different. - Check permissions. Folder to import from must be readable by user www-data. To test, run:
sudo -u www-data cp -r /path/to/wiki/wiki-backup-dump-content-current/mediafiles /tmp/delete
or so.
Alternative Wiki Backup Formats[edit]
These alternative wiki backup formats are for archives and developers only.
- C) Kicksecure wiki as
mediawiki markdown
- Nicer looking database format (markdown instead of XML ("binary") database dump).
- No automated path to restoration in MediaWiki. This would probably have to be automated using [1] or similar.
rsync://kicksecure.com/kicksecure/developer-meta-files/kicksecure-wiki-backup
- D) Kicksecure wiki as
HTML
- No automated path to restoration.
Forum Backups[edit]
For archives and developers only.
We believe security software like Kicksecure needs to remain Open Source and independent. Would you help sustain and grow the project? Learn more about our 12 year success story and maybe DONATE!